home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dskut / docp_1_1.zip / DOC.H < prev    next >
Text File  |  1992-04-29  |  10KB  |  230 lines
  1. #define FULL_DOC1 \
  2. "docp - directory-oriented file copy\
  3. \nVersion 1.1, Copyright (c) 1992, Roy Bixler\
  4. \n\
  5. \nGeneral Idea:\
  6. \n\
  7. \n    Docp is a directory-oriented copy program.  It gives you better\
  8. \n    control over which files you can copy or move.  In the simplest\
  9. \n    case, all files are copied from the source directory to the target\
  10. \n    directory.  A list of files can be specified to limit what is\
  11. \n    copied.  This list can have wild-card file specifications (default\
  12. \n    list = *.*) and may be applied against either the source or target\
  13. \n    directory (default = source).  If a file specification in the list\
  14. \n    starts with a '-', it is excluded from the copy.  File dates and\
  15. \n    times can be used to limit the file list.  Recursive copies are\
  16. \n    also supported.\
  17. \n\
  18. \nUsage:\
  19. \n\
  20. \n    docp [-abcdfghijlmnorstvwz?] source_dir target_dir [file_list]\
  21. \n\
  22. \nOptions:\
  23. \n\
  24. \n    Multiple criteria options ('-a', '-d', '-n', '-o', and '-w') are\
  25. \n    AND'ed together.  For example, specifying '-an' means copy the\
  26. \n    source files which are newer and have the archive bit set.  If\
  27. \n    either condition is false, the copy will not be done.  If you wish\
  28. \n    to copy either the newer files or the files with the archive bit\
  29. \n    set, just do two separate 'docp' commands (i.e. 'docp -a' followed\
  30. \n    by 'docp -n').\
  31. \n\
  32. \n    The options are described below:\
  33. \n\
  34. \n    -a - Use archive bit\
  35. \n        Copy only files which have the archive bit set.  Once the copy\
  36. \n        is complete, the archive bit for the source file will be\
  37. \n        turned off.\
  38. \n\
  39. \n    -b - Batch mode.\
  40. \n        Turn off all interactive prompts.  Where questions are\
  41. \n        normally asked, the following default actions are taken\
  42. \n        instead.  If the target directory does not exist, try to\
  43. \n        create it.  If a target file is read-only, delete the target\
  44. \n        and re-try the copy.  Also, if the target device fills up, the\
  45. \n        program simply prints a message and aborts.\
  46. \n\
  47. \n    -c - Check\
  48. \n        Check the operation of the 'docp' command without actually\
  49. \n        copying any files.  This mode sets the verbose options.\
  50. \n\
  51. \n    -d [boa]mm/dd/yy - Date\
  52. \n        Copy files based on the date that they were last changed.\
  53. \n        This flag takes one argument starting with the letters 'b',\
  54. \n        'o', or 'a', followed by the date in the form, mm/dd/yy.  The\
  55. \n        prefix 'b' stands for 'before' but not including the specified\
  56. \n        date.  The prefix 'o' stands for 'on' the specified date, and\
  57. \n        'a' stands for 'after' the specified date.  The date ranges\
  58. \n        specified using the 'a' and 'b' prefixes are 'and-ed'\
  59. \n        together.  The 'o' dates are then 'or-ed' with the result.\
  60. \n        For example to specify all files last-changed during March,\
  61. \n        you could type:\
  62. \n            docp -vd ao3/1/91 -d b4/1/91 . a:"
  63.  
  64. #define FULL_DOC2 "\
  65. \n\
  66. \n    -f file_name - File\
  67. \n       Get the file list from the file which is specified as an\
  68. \n       argument following the '-f' flag.  If the file_name is \"-\" then\
  69. \n       the file list will come from standard input.\
  70. \n\
  71. \n    -g - Gather\
  72. \n        Gather the files from the source directory and all its\
  73. \n        subdirectories into the one target directory.\
  74. \n\
  75. \n    -h - Hidden\
  76. \n        Copy hidden files as well as non-hidden files.  Applies to\
  77. \n        '-z - zap target' option below.\
  78. \n\
  79. \n    -i - Interactive\
  80. \n        Interactively ask the user if he wishes to copy each file,\
  81. \n        before the copy occurs.  Also applies to '-z - zap target'\
  82. \n        option below.\
  83. \n\
  84. \n    -j - Join files\
  85. \n        This is the companion of the '-l' option (see below).  If a\
  86. \n        file with the same name as the source file exists in the\
  87. \n        target directory, append the source file to the target file.\
  88. \n\
  89. \n    -l - Larger than target\
  90. \n        Split up files that are larger than target.  See the 'Disk\
  91. \n        Overflow' section below for further explanation.\
  92. \n\
  93. \n    -m - Move\
  94. \n        Removes all copied files from the source directory.\
  95. \n\
  96. \n    -n - Newer\
  97. \n        Copy only newer files.  If the source file already has a copy\
  98. \n        in the target directory, then the copy or move only occurs if\
  99. \n        the source file has a later date/time stamp then the target\
  100. \n        copy.  If a source file does not already exist in the target\
  101. \n        directory, then the source file is copied. This option can be\
  102. \n        handy for doing fast backups.\
  103. \n\
  104. \n    -o - Older\
  105. \n        Copy only older files.  If the source file already has a copy\
  106. \n        in the target directory, then the copy or move only occurs if\
  107. \n        the source file has an earlier date/time stamp then the target\
  108. \n        copy.  If a source file does not already exist in the target\
  109. \n        directory, then the source file is copied. This option can be\
  110. \n        handy for quickly restoring backups.\
  111. \n\
  112. \n    -no - Not On target\
  113. \n        Copy only if the source file does not exist in the target\
  114. \n        directory.  This is a trick that uses the '-n' and '-o'\
  115. \n        options.\
  116. \n\
  117. \n    -r - Recursive\
  118. \n        Recursively copy all of the subdirectories of the source\
  119. \n        directory.  Subdirectories that don't already exist under the\
  120. \n        target directory are created.  Also, if the '-z - zap target'\
  121. \n        option is specified, recursively deletes target subdirectories.\
  122. \n\
  123. \n    -s - Source\
  124. \n        Apply the file list to the source directory. This is the\
  125. \n        default.  The alternative is '-t'.\
  126. \n\
  127. \n    -t - Target\
  128. \n        Apply the file list to the target directory. For example,\
  129. \n        typing 'docp -t . a:', would copy only those files in the\
  130. \n        current directory which were already on the 'A' drive.  This\
  131. \n        is handy for doing backups."
  132.  
  133. #define FULL_DOC3 "\
  134. \n\
  135. \n    -v - Verbose\
  136. \n        Report all files that are copied or moved.\
  137. \n\
  138. \n    -vv - Very Verbose\
  139. \n        Report all files that are copied or not copied.\
  140. \n\
  141. \n    -w [ba]hh:mm[pa] - When\
  142. \n        Copy files based on the time that they were last changed.\
  143. \n        This flag takes one argument starting with the letters 'b', or\
  144. \n        'a', followed by the time in the form, hh:mm[ap].  The prefix\
  145. \n        'b' stands for 'before' but not including the specified time.\
  146. \n        and the prefix 'a' stands for 'after' the specified date.  The\
  147. \n        time ranges specified using the 'a' and 'b' prefixes are\
  148. \n        'and-ed' together.  For example to specify all files\
  149. \n        last-changed after 10:00pm but before 11:00pm you could type:\
  150. \n            docp -vt a10:00p -t b11:00p . a:\
  151. \n        If this option is used without the date option, then the\
  152. \n        current system date is assumed.\
  153. \n\
  154. \n    -z - Zap\
  155. \n        Zap (i.e. clear all files) in the target directory\
  156. \n        (or directories) before copying.\
  157. \n\
  158. \n    -?\
  159. \n        Print full documentation and exit.  You are here!\
  160. \n\
  161. \nDisk Overflow:\
  162. \n\
  163. \n    If the destination drive is full during a copy, then 'docp' will\
  164. \n    pause and allow the user to change diskettes.  If the user\
  165. \n    specified '-o', '-n', or '-t' then she will not be able to change\
  166. \n    floppies.  This is because the original floppy was used to\
  167. \n    determine which files to copy.  The '-l' option is useful here,\
  168. \n    since the file that caused the target to be full will remain on\
  169. \n    the current target and will continue to be copied on the new\
  170. \n    target as a split file.  Without '-l', this file will be erased on\
  171. \n    the current target and the copy will be retried on the new target.\
  172. \n\
  173. \nFile List:\
  174. \n\
  175. \n    If not specified, the default file list is '*.*'.  Any files\
  176. \n    prefixed with '-' will be excluded from the file list.  For\
  177. \n    example, to copy all files in a directory except a file called\
  178. \n    'junk' or those with a '.obj' suffix, you